/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2008-2011, Salzburg Research. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * - Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 * - Neither the name of the KiWi Project nor the names of its contributors
 * may be used to endorse or promote products derived from this software
 * without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * Contributor(s):
 * sschaffe
 *
 * File Info:
 * User: sschaffe
 * Date: 2011/01/17
 * Time: 11:25
 *
 * Project: KiWi2, kiwi-core module
 */

package kiwi.core.api.io;

import kiwi.core.exception.ParsingException;
import org.openrdf.repository.Repository;

import java.io.IOException;
import java.io.InputStream;
import java.io.Reader;
import java.util.List;

/**
 * A KiWi parser allows to parse triple data in various formats. The result of parsing is a Sesame in-memory repository.
 * The reason why we do not use KiWiTriples is that they are directly bound to the KiWi triple store and thus to the
 * database and it is often desirable to have an intermediate representation of triples. The KiWi Sesame Tools can be
 * used to convert back and forth between Sesame and KiWi triple representations.
 *
 *
 * @see Repository
 * @see org.openrdf.sail.memory.MemoryStore
 *
 * <p/>
 * User: sschaffe
 */
public interface KiWiParser {

	/**
	 * Return all mimetypes that are accepted by this parser
	 * @return a list of mimetype strings
	 */
	public List<String> getAcceptFormats();

    /**
     * Parse the triple data contained in the string passed as argument and return a Sesame in-memory repository for
     * further processing.
     *
     * @param data a string containing the triple data in the format implemented by this parser
     * @throws ParsingException if the string passed as argument does not have the right format
     * @return a Sesame in-memory repository containing the parsed triple data
     */
    public Repository parseTriples(String data) throws ParsingException;


     /**
      * Parse the triple data contained in the reader passed as argument and return a Sesame in-memory repository for
      * further processing.
      *
      * @param reader a Reader from which the triple data in the format implemented by this parser can be read
      * @throws ParsingException if the data read from the Reader does not have the right format
      * @return a Sesame in-memory repository containing the parsed triple data
      */
    public Repository parseTriples(Reader reader) throws ParsingException, IOException;


    /**
     * Parse the triple data contained in the reader passed as argument and return a Sesame in-memory repository for
     * further processing.
     *
     * @param in an InputStream from which the triple data in the format implemented by this parser can be read
     * @throws ParsingException if the data read from the stream does not have the right format
     * @return a Sesame in-memory repository containing the parsed triple data
     */
    public Repository parseTriples(InputStream in) throws ParsingException, IOException;

}
